<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSpinner: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
<link rel="prev" href="GtkImage.html" title="GtkImage">
<link rel="next" href="GtkInfoBar.html" title="GtkInfoBar">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkSpinner.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkSpinner.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkSpinner.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkSpinner.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkImage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkInfoBar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSpinner"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSpinner.top_of_page"></a>GtkSpinner</span></h2>
<p>GtkSpinner — Show a spinner animation</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="spinner.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSpinner.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-new" title="gtk_spinner_new ()">gtk_spinner_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-start" title="gtk_spinner_start ()">gtk_spinner_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-stop" title="gtk_spinner_stop ()">gtk_spinner_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkSpinner.html#GtkSpinner--active" title="The “active” property">active</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSpinner.html#GtkSpinner-struct" title="struct GtkSpinner">GtkSpinner</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
            <span class="lineart">╰──</span> GtkSpinner
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSpinner implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSpinner.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.description"></a><h2>Description</h2>
<p>A GtkSpinner widget displays an icon-size spinning animation.
It is often used as an alternative to a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> for
displaying indefinite activity, instead of actual progress.</p>
<p>To start the animation, use <a class="link" href="GtkSpinner.html#gtk-spinner-start" title="gtk_spinner_start ()"><code class="function">gtk_spinner_start()</code></a>, to stop it
use <a class="link" href="GtkSpinner.html#gtk-spinner-stop" title="gtk_spinner_stop ()"><code class="function">gtk_spinner_stop()</code></a>.</p>
<div class="refsect2">
<a name="id-1.3.8.4.9.4"></a><h3>CSS nodes</h3>
<p>GtkSpinner has a single CSS node with the name spinner. When the animation is
active, the :checked pseudoclass is added to this node.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-spinner-new"></a><h3>gtk_spinner_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_spinner_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a new spinner widget. Not yet started.</p>
<div class="refsect3">
<a name="gtk-spinner-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p>
</div>
<p class="since">Since: 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spinner-start"></a><h3>gtk_spinner_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spinner_start (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);</pre>
<p>Starts the animation of the spinner.</p>
<div class="refsect3">
<a name="gtk-spinner-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spinner</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spinner-stop"></a><h3>gtk_spinner_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spinner_stop (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);</pre>
<p>Stops the animation of the spinner.</p>
<div class="refsect3">
<a name="gtk-spinner-stop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spinner</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.20</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSpinner-struct"></a><h3>struct GtkSpinner</h3>
<pre class="programlisting">struct GtkSpinner;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSpinner--active"></a><h3>The <code class="literal">“active”</code> property</h3>
<pre class="programlisting">  “active”                   <span class="type">gboolean</span></pre>
<p>Whether the spinner is active.</p>
<p>Owner: GtkSpinner</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkCellRendererSpinner.html" title="GtkCellRendererSpinner"><span class="type">GtkCellRendererSpinner</span></a>, <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>